home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / XmDragIcon.z / XmDragIcon
Encoding:
Text File  |  1998-10-20  |  16.4 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn - The DragIcon widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////DDDDrrrraaaaggggDDDDrrrroooopppp....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           A DragIcon is a component of the visual used to represent
  20.           the source data in a drag and drop transaction.  During a
  21.           drag operation, a real or simulated X cursor provides drag-
  22.           over visuals consisting of a static portion that represents
  23.           the object being dragged, and dynamic cues that provide
  24.           visual feedback during the drag operation.  The visual is
  25.           attained by blending together various XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnnssss specified
  26.           in the XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt associated with the drag operation.
  27.  
  28.           The static portion of the drag-over visual is the graphic
  29.           representation that identifies the drag source.  For
  30.           example, when a user drags several items within a list, a
  31.           DragIcon depicting a list might be supplied as the visual.
  32.           The XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt resources, XXXXmmmmNNNNssssoooouuuurrrrcccceeeeCCCCuuuurrrrssssoooorrrrIIIIccccoooonnnn or
  33.           XXXXmmmmNNNNssssoooouuuurrrrcccceeeePPPPiiiixxxxmmmmaaaappppIIIIccccoooonnnn, specify a DragIcon to use for the
  34.           static portion of the visual.
  35.  
  36.           A drag-over visual incorporates dynamic cues in order to
  37.           provide visual feedback in response to the user's actions.
  38.           For instance, the drag-over visual might use different
  39.           indicators to identify the type of operation (copy, link, or
  40.           move) being performed.  Dynamic cues could also alert the
  41.           user that a drop site is valid or invalid as the pointer
  42.           traverses the drop site.  The XXXXmmmmNNNNooooppppeeeerrrraaaattttiiiioooonnnnCCCCuuuurrrrssssoooorrrrIIIIccccoooonnnn and
  43.           XXXXmmmmNNNNssssttttaaaatttteeeeCCCCuuuurrrrssssoooorrrrIIIIccccoooonnnn resources of XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt specify
  44.           DragIcons for dynamic cues.
  45.  
  46.           A drag-over visual typically consists of a source, operation
  47.           and state DragIcon.  The XXXXmmmmNNNNbbbblllleeeennnnddddMMMMooooddddeeeellll resource of
  48.           XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt offers several options that determine which
  49.           icons are blended to produce the drag-over visual.  DragIcon
  50.           resources control the relative position of the operation and
  51.           state icons (if used).  If a particular DragIcon is not
  52.           specified, the toolkit uses the XXXXmmmmSSSSccccrrrreeeeeeeennnn default DragIcons.
  53.  
  54.           An application initializes a DragIcon with the function
  55.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeDDDDrrrraaaaggggIIIIccccoooonnnn or through entries in the resource
  56.           database.  If a pixmap and its mask (optional) are specified
  57.           in the resource database, the toolkit converts the values in
  58.           the X11 Bitmap file format and assigns values to the
  59.           corresponding resources.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  71.  
  72.  
  73.  
  74.         CCCCllllaaaasssssssseeeessss
  75.           DragIcon inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.
  76.  
  77.           The class pointer is xxxxmmmmDDDDrrrraaaaggggIIIIccccoooonnnnOOOObbbbjjjjeeeeccccttttCCCCllllaaaassssssss.
  78.  
  79.           The class name is XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn.
  80.  
  81.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  82.           The following table defines a set of widget resources used
  83.           by the programmer to specify data.  The programmer can also
  84.           set the resource values for the inherited classes to set
  85.           attributes for this widget.  To reference a resource by name
  86.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  87.           prefix and use the remaining letters.  To specify one of the
  88.           defined values for a resource in a .Xdefaults file, remove
  89.           the XXXXmmmm prefix and use the remaining letters (in either
  90.           lowercase or uppercase, but include any underscores between
  91.           words).  The codes in the access column indicate if the
  92.           given resource can be set at creation time (CCCC), set by using
  93.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (SSSS), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (GGGG), or is
  94.           not applicable (NNNN////AAAA).
  95.  
  96.                                 XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  97.      NNNNaaaammmmeeee            CCCCllllaaaassssssss           TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  98.      _____________________________________________________________________________
  99.      XmNattachment   XmCAttachment   unsigned char   XmATTACH_NORTH_WEST    CSG
  100.      XmNdepth        XmCDepth        int             1                      CSG
  101.      XmNheight       XmCHeight       Dimension       0                      CSG
  102.      XmNhotX         XmCHot          Position        0                      CSG
  103.      XmNhotY         XmCHot          Position        0                      CSG
  104.      XmNmask         XmCPixmap       Pixmap          XmUNSPECIFIED_PIXMAP   CSG
  105.      XmNoffsetX      XmCOffset       Position        0                      CSG
  106.      XmNoffsetY      XmCOffset       Position        0                      CSG
  107.      XmNpixmap       XmCPixmap       Pixmap          XmUNSPECIFIED_PIXMAP   CSG
  108.      XmNwidth        XmCWidth        Dimension       0                      CSG
  109.  
  110.           XXXXmmmmNNNNaaaattttttttaaaacccchhhhmmmmeeeennnntttt
  111.                       Specifies a relative location on the source icon
  112.                       for the attachment of the state or operation
  113.                       icon.  The origin of the state and operation
  114.                       icons is aligned with the specified compass
  115.                       point on the source icon.  The XXXXmmmmNNNNooooffffffffsssseeeettttXXXX and
  116.                       XXXXmmmmNNNNooooffffffffsssseeeettttYYYY resources can be used to further
  117.                       refine the icon positions.  The possible values
  118.                       are
  119.  
  120.  
  121.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____NNNNOOOORRRRTTTTHHHH____WWWWEEEESSSSTTTT
  122.                                 Attaches the origin of the state or
  123.                                 operation icon to the northwest point
  124.                                 on the source icon.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____NNNNOOOORRRRTTTTHHHH
  141.                                 Attaches the origin of the state or
  142.                                 operation icon to the north point on
  143.                                 the source icon.
  144.  
  145.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____NNNNOOOORRRRTTTTHHHH____EEEEAAAASSSSTTTT
  146.                                 Attaches the origin of the state or
  147.                                 operation icon to the northeast point
  148.                                 on the source icon.
  149.  
  150.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____EEEEAAAASSSSTTTT
  151.                                 Attaches the origin of the state or
  152.                                 operation icon to the east point on
  153.                                 the source icon.
  154.  
  155.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____SSSSOOOOUUUUTTTTHHHH____EEEEAAAASSSSTTTT
  156.                                 Attaches the origin of the state or
  157.                                 operation icon to the southeast point
  158.                                 on the source icon.
  159.  
  160.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____SSSSOOOOUUUUTTTTHHHH
  161.                                 Attaches the origin of the state or
  162.                                 operation icon to the south point on
  163.                                 the source icon.
  164.  
  165.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____SSSSOOOOUUUUTTTTHHHH____WWWWEEEESSSSTTTT
  166.                                 Attaches the origin of the state or
  167.                                 operation icon to the southwest point
  168.                                 on the source icon.
  169.  
  170.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____WWWWEEEESSSSTTTT
  171.                                 Attaches the origin of the state or
  172.                                 operation icon to the west point on
  173.                                 the source icon.
  174.  
  175.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____CCCCEEEENNNNTTTTEEEERRRR
  176.                                 Attaches the origin of the state or
  177.                                 operation icon to the center of the
  178.                                 source icon.  The XXXXmmmmNNNNooooffffffffsssseeeettttXXXX and
  179.                                 XXXXmmmmNNNNooooffffffffsssseeeettttYYYY resources may be used to
  180.                                 center the attached icon.
  181.  
  182.                       XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____HHHHOOOOTTTT
  183.                                 Attaches the hotspot coordinates of a
  184.                                 state or operation DragIcon to an _x,_y
  185.                                 position on the source icon.  The _x,_y
  186.                                 coordinate is taken from the event
  187.                                 passed to the XXXXmmmmDDDDrrrraaaaggggSSSSttttaaaarrrrtttt function,
  188.                                 and made relative to the widget passed
  189.                                 as an argument to the same function.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           XXXXmmmmNNNNddddeeeepppptttthhhh    Specifies the depth of the pixmap.
  207.  
  208.           XXXXmmmmNNNNhhhheeeeiiiigggghhhhtttt   Specifies the height of the pixmap.
  209.  
  210.           XXXXmmmmNNNNhhhhoooottttXXXX     Specifies the x-coordinate of the hotspot of a
  211.                       cursor DragIcon in relation to the origin of the
  212.                       pixmap bounding box.
  213.  
  214.           XXXXmmmmNNNNhhhhoooottttYYYY     Specifies the y-coordinate of the hotspot of a
  215.                       cursor DragIcon in relation to the origin of the
  216.                       pixmap bounding box.
  217.  
  218.           XXXXmmmmNNNNmmmmaaaasssskkkk     Specifies a pixmap of depth one to use as the
  219.                       DragIcon mask pixmap.
  220.  
  221.           XXXXmmmmNNNNooooffffffffsssseeeettttXXXX  Specifies a horizontal offset (in pixels) of the
  222.                       origin of the state or operation icon relative
  223.                       to the attachment point on the source icon.  A
  224.                       positive offset value moves the origin to the
  225.                       right; a negative value moves the origin to the
  226.                       left.
  227.  
  228.           XXXXmmmmNNNNooooffffffffsssseeeettttYYYY  Specifies a vertical offset (in pixels) of the
  229.                       origin of the state or operation icon relative
  230.                       to the attachment point on the source icon.  A
  231.                       positive offset value moves the origin down; a
  232.                       negative value moves the origin up.
  233.  
  234.           XXXXmmmmNNNNppppiiiixxxxmmmmaaaapppp   Specifies a pixmap to use as the DragIcon
  235.                       pixmap.
  236.  
  237.           XXXXmmmmNNNNwwwwiiiiddddtttthhhh    Specifies the width of the pixmap.
  238.  
  239.  
  240.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  241.           DragIcon inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.  For
  242.           a complete description of this resource, refer to the OOOObbbbjjjjeeeecccctttt
  243.           man page.
  244.  
  245.                               OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  246.       NNNNaaaammmmeeee                 CCCCllllaaaassssssss         TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  247.       ____________________________________________________________________
  248.       XmNdestroyCallback   XmCCallback   XtCallbackList   NULL      C
  249.  
  250.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  251.           OOOObbbbjjjjeeeecccctttt((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX)))), XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))),
  252.           XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt((((3333XXXX)))), XXXXmmmmDDDDrrrrooooppppSSSSiiiitttteeee((((3333XXXX)))), XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX)))), and
  253.           XXXXmmmmSSSSccccrrrreeeeeeeennnn((((3333XXXX)))).
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.